fix: repair documented workflows and API references - #115

📄 CodeRabbit inference engine (.agents/skills/contribute-docs/SKILL.md)

Keep package names, repository references, and build commands current in documentation and examples.

Files:

• docs/sdk/python.mdx
• docs/reference/api/python-library-reference/nemo_fabric.models.md

📄 CodeRabbit inference engine (.agents/skills/contribute-docs/SKILL.md)

Update relevant getting-started, reference, adapter, and example documentation when the corresponding examples or adapters change.

Files:

• docs/sdk/python.mdx
• docs/reference/api/python-library-reference/nemo_fabric.models.md

📄 CodeRabbit inference engine (.agents/skills/contribute-docs/SKILL.md)

In MDX files, use JSX comment delimiters ({/* and */}) for top-of-file comments, including SPDX headers; do not use HTML comments.

Use {/* ... */} delimiters for top-of-file MDX SPDX comments, not HTML comment delimiters.

**/*.mdx: For documentation-site changes, run just docs to regenerate Python and Rust API references and validate Fern configuration.
MDX files must use the specified JSX-comment SPDX header format.

Files:

• docs/sdk/python.mdx

📄 CodeRabbit inference engine (.agents/skills/contribute-docs/SKILL.md)

Run just docs when the documentation site changes.

Files:

• docs/sdk/python.mdx
• docs/reference/api/python-library-reference/nemo_fabric.models.md

📄 CodeRabbit inference engine (.agents/skills/karpathy-guidelines/SKILL.md)

**/*: Before implementing, explicitly state assumptions, surface ambiguity and tradeoffs, present multiple interpretations when relevant, and ask for clarification rather than silently deciding or proceeding when requirements are unclear.
Prefer the minimum code needed to solve the requested problem: avoid speculative features, unnecessary abstractions, unrequested flexibility, and handling of impossible scenarios; simplify overcomplicated solutions.
When editing existing code, make surgical changes only: do not modify unrelated code, comments, formatting, or pre-existing dead code; match the existing style, and remove only unused imports, variables, or functions introduced by your changes.
Define verifiable success criteria for each task, such as writing regression tests for bugs and invalid-input tests for validation, then verify the implementation against those criteria. For multi-step work, state a brief plan with a verification check for each step.

**/*: Always spell NVIDIA in all caps; do not use Nvidia, nvidia, nVidia, nVIDIA, or NV.
Use an NVIDIA before a noun, because the name begins with an “en” sound.
Do not add a registered trademark symbol after NVIDIA when referring to the company; use trademark symbols with product names only when required by the document type or legal guidance.
Verify official capitalization, spacing, hyphenation, and spelling for NVIDIA and third-party product names; do not rewrite official product names for grammar or title-case rules.
Precede NVIDIA product names with NVIDIA on first mention when natural and accurate, and link the first mention when the destination helps the reader.
On first use, include the company name and full model qualifier when it helps identify the model; preserve official capitalization and punctuation, and use shorter family names only after establishing the full name.
For learning-oriented and developer content, do not force trademark symbols unless explicitly required; for press, ...

Files:

• docs/sdk/python.mdx
• docs/reference/api/python-library-reference/nemo_fabric.models.md

📄 CodeRabbit inference engine (.agents/skills/review-doc-style/assets/nvidia-style-guide.md)

**/*.{md,mdx,rst}: For NeMo Fabric documentation, verify technical claims against the current repository, public API, or documented command before reviewing style.
Always spell NVIDIA in all caps; do not use Nvidia, nvidia, or NV.
Format commands, code elements, expressions, package names, file names, and paths as inline code.
Use descriptive link text; avoid raw URLs and weak anchors such as here or read more.
Use title case consistently for technical documentation headings.
Introduce code blocks, lists, tables, and images with complete sentences.
Write procedures as imperative, parallel steps; split long procedures into smaller tasks.
Prefer active voice, present tense, short sentences, contractions, and plain English while preserving necessary technical precision.
Use can for possibility and reserve may for permission.
Use after for temporal relationships instead of once, and prefer refer to over see when directing readers to another resource.
Avoid culture-specific idioms, unnecessary Latinisms, jokes, and marketing exaggeration in technical documentation.
Spell out months in body text, avoid ordinal dates, and use clear time zones.
Spell out whole numbers from zero through nine unless they are technical values, parameters, versions, or UI values; use numerals for 10 or greater and commas in thousands.
Do not add trademark symbols to learning-oriented documentation unless the source, platform, or legal guidance explicitly requires them.
Do not replace precise technical terms with simpler words when doing so would lose precision.
Do not flag passive voice when the actor is unknown or the action is the important part.
Do not rewrite API names, package names, command flags, or code literals for style.

**/*.{md,mdx,rst}: Use consistent title case for technical-document headings and table headers; avoid quotation marks, ampersands, and exclamation marks in headings, while preserving official product, event, research, and whitepaper title ...

Files:

• docs/sdk/python.mdx
• docs/reference/api/python-library-reference/nemo_fabric.models.md

📄 CodeRabbit inference engine (AGENTS.md)

Update Fern documentation under docs/ when public behavior, the nemo-fabric package, examples, or supported bindings change.

Files:

• docs/sdk/python.mdx
• docs/reference/api/python-library-reference/nemo_fabric.models.md

📄 CodeRabbit inference engine (AGENTS.md)

Keep docs/sdk/python.mdx current when the public Python API changes.

Files:

• docs/sdk/python.mdx

📄 CodeRabbit inference engine (.agents/skills/review-doc-style/SKILL.md)

**/*.{md,mdx}: Use the full product name NVIDIA NeMo Fabric on its first usage, typically in the title or H1; use NeMo Fabric thereafter.
Use fabric by itself only when referring to the CLI tool, and surround those references with backticks.
Capitalize NVIDIA correctly in public documentation.
Format commands, code elements, expressions, file names, paths, and filenames as inline code where needed.
Use title case consistently for headings in technical documentation.
Introduce code blocks, tables, and lists with complete lead-in sentences.
Use descriptive anchor text instead of raw URLs or generic link text such as here.
Prefer active voice, present tense, short sentences, and plain English.
Use consistent terminology for the same concept throughout a document.
Write procedures as imperative, parallel, easy-to-scan steps, and split long sequences into smaller tasks.
Use after instead of once when expressing temporal sequence.
Use can instead of may when the intended meaning is possibility rather than permission.
Avoid ambiguous numeric dates and ordinal dates in body text.
For learning-oriented documentation, do not force trademark symbols unless the source document explicitly requires them.
Introduce examples' code blocks with full sentences and ensure examples match current APIs and build commands.

Update corresponding documentation when public behavior, adapters, examples, or workspace structure changes.

Files:

• docs/sdk/python.mdx
• docs/reference/api/python-library-reference/nemo_fabric.models.md

⚙️ CodeRabbit configuration file

{docs/**,README.md,AGENTS.md}: Review documentation for technical accuracy against the current API, command correctness, and consistency with generated schemas.

Files:

• docs/sdk/python.mdx
• docs/reference/api/python-library-reference/nemo_fabric.models.md

⚙️ CodeRabbit configuration file

{*.md,**/*.md,**/*.mdx,**/*.ipynb}: Enforce the product name in user-facing prose: use "NVIDIA NeMo Fabric" on first use and "NeMo Fabric" thereafter. Flag standalone capitalized "Fabric" when it refers to the product. Do not flag the lowercase fabric CLI command, package/import/crate names, code identifiers, API symbols, configuration keys, file paths, or unrelated generic uses of the word.

Files:

• docs/sdk/python.mdx
• docs/reference/api/python-library-reference/nemo_fabric.models.md

📄 CodeRabbit inference engine (.agents/skills/contribute-api/SKILL.md)

Update documentation and examples in the same branch as the public API change.

Files:

• docs/reference/api/python-library-reference/nemo_fabric.models.md

📄 CodeRabbit inference engine (.agents/skills/review-doc-style/assets/nvidia-style-language-mechanics.md)

**/*.{md,rst,txt,adoc}: For technical documentation, use professional, active, conversational, engaging, precise, and plain-English prose. Prefer active voice, present tense, short sentences, and scannable paragraphs. Avoid casual or imprecise language, swearing, threats, insults, jokes, puns, culture-specific idioms, marketing exaggeration, and unsupported third-party comparisons.
Use can for possibility and reserve may for permission; use after for temporal order; use refer to for cross-references; prefer short direct sentences and specific verbs; avoid unnecessary please in technical documentation.
Prefer active voice when the actor matters. Passive voice is acceptable when the actor is unknown or irrelevant, when the action or result is the focus, or in programmer documentation.
Use natural contractions in conversational technical prose, but do not force them in formal legal copy, API references, or generated text.
Prefer simpler English over Latinisms: use for example or such as instead of e.g., and so on instead of etc., that is instead of i.e., compared to instead of vs., and by, through, or using instead of via. Use industry-standard terms such as in silico, in vitro, and in vivo when appropriate, and italicize them in running text.
Use that without commas for essential clauses, and which with commas for nonessential clauses.
Format dates and times clearly: spell out months in body text; use forms such as June 12, 2025; avoid numeric or ordinal dates; capitalize days; use 12-hour time when appropriate; include a space before a.m. or p.m.; use ET and PT for needed time zones; avoid 24/7; and prefer from 12:30 to 1:00 p.m. for prose ranges.
Format numbers consistently: spell out zero through nine in body text, use numerals for 10 or greater and for technical values, use commas in thousands, do not begin a sentence with a numeral, spell out ordinals, and use numerals consistently within a category wh...

Files:

• docs/reference/api/python-library-reference/nemo_fabric.models.md

📄 CodeRabbit inference engine (AGENTS.md)

Regenerate or update generated API references under docs/reference/api/ when the public API changes.

Treat all files under docs/reference/api/ as generated output and do not modify them directly.

Files:

• docs/reference/api/python-library-reference/nemo_fabric.models.md

📄 CodeRabbit inference engine (CONTRIBUTING.md)

HTML/Markdown source files must use the specified HTML-comment SPDX header format.

Files:

• docs/reference/api/python-library-reference/nemo_fabric.models.md

📄 CodeRabbit inference engine (.agents/skills/contribute-adapter/SKILL.md)

Keep package wiring, descriptors, dependencies, installation, catalogs, CI enumerations, documentation, examples, fixtures, and generated artifacts consistent with the adapter implementation.

Files:

• docs/reference/api/python-library-reference/nemo_fabric.models.md

[warning] 773-773: Headings should be surrounded by blank lines
Expected: 1; Actual: 0; Below

(MD022, blanks-around-headings)

[warning] 845-845: Headings should be surrounded by blank lines
Expected: 1; Actual: 0; Below

(MD022, blanks-around-headings)

📄 CodeRabbit inference engine (.agents/skills/contribute-api/SKILL.md)

Update documentation and examples in the same branch as the public API change.

Files:

• docs/reference/api/python-library-reference/nemo_fabric.runtime.md
• docs/reference/api/python-library-reference/nemo_fabric.client.md
• docs/reference/api/python-library-reference/nemo_fabric.errors.md
• docs/reference/api/python-library-reference/nemo_fabric.types.md
• docs/reference/api/python-library-reference/nemo_fabric.models.md

📄 CodeRabbit inference engine (.agents/skills/contribute-docs/SKILL.md)

Keep package names, repository references, and build commands current in documentation and examples.

Files:

• docs/reference/api/python-library-reference/nemo_fabric.runtime.md
• docs/reference/api/python-library-reference/nemo_fabric.client.md
• docs/reference/api/python-library-reference/nemo_fabric.errors.md
• docs/reference/api/python-library-reference/nemo_fabric.types.md
• docs/reference/api/python-library-reference/nemo_fabric.models.md

📄 CodeRabbit inference engine (.agents/skills/contribute-docs/SKILL.md)

Update relevant getting-started, reference, adapter, and example documentation when the corresponding examples or adapters change.

Files:

• docs/reference/api/python-library-reference/nemo_fabric.runtime.md
• docs/reference/api/python-library-reference/nemo_fabric.client.md
• docs/reference/api/python-library-reference/nemo_fabric.errors.md
• docs/reference/api/python-library-reference/nemo_fabric.types.md
• docs/reference/api/python-library-reference/nemo_fabric.models.md

📄 CodeRabbit inference engine (.agents/skills/contribute-docs/SKILL.md)

Run just docs when the documentation site changes.

Files:

• docs/reference/api/python-library-reference/nemo_fabric.runtime.md
• docs/reference/api/python-library-reference/nemo_fabric.client.md
• docs/reference/api/python-library-reference/nemo_fabric.errors.md
• docs/reference/api/python-library-reference/nemo_fabric.types.md
• docs/reference/api/python-library-reference/nemo_fabric.models.md

📄 CodeRabbit inference engine (.agents/skills/karpathy-guidelines/SKILL.md)

**/*: Before implementing, explicitly state assumptions, surface ambiguity and tradeoffs, present multiple interpretations when relevant, and ask for clarification rather than silently deciding or proceeding when requirements are unclear.
Prefer the minimum code needed to solve the requested problem: avoid speculative features, unnecessary abstractions, unrequested flexibility, and handling of impossible scenarios; simplify overcomplicated solutions.
When editing existing code, make surgical changes only: do not modify unrelated code, comments, formatting, or pre-existing dead code; match the existing style, and remove only unused imports, variables, or functions introduced by your changes.
Define verifiable success criteria for each task, such as writing regression tests for bugs and invalid-input tests for validation, then verify the implementation against those criteria. For multi-step work, state a brief plan with a verification check for each step.

**/*: Always spell NVIDIA in all caps; do not use Nvidia, nvidia, nVidia, nVIDIA, or NV.
Use an NVIDIA before a noun, because the name begins with an “en” sound.
Do not add a registered trademark symbol after NVIDIA when referring to the company; use trademark symbols with product names only when required by the document type or legal guidance.
Verify official capitalization, spacing, hyphenation, and spelling for NVIDIA and third-party product names; do not rewrite official product names for grammar or title-case rules.
Precede NVIDIA product names with NVIDIA on first mention when natural and accurate, and link the first mention when the destination helps the reader.
On first use, include the company name and full model qualifier when it helps identify the model; preserve official capitalization and punctuation, and use shorter family names only after establishing the full name.
For learning-oriented and developer content, do not force trademark symbols unless explicitly required; for press, ...

Files:

• docs/reference/api/python-library-reference/nemo_fabric.runtime.md
• scripts/docs/enhance_python_api_reference.py
• tests/docs/test_python_api_docs.py
• docs/reference/api/python-library-reference/nemo_fabric.client.md
• docs/reference/api/python-library-reference/nemo_fabric.errors.md
• docs/reference/api/python-library-reference/nemo_fabric.types.md
• docs/reference/api/python-library-reference/nemo_fabric.models.md

📄 CodeRabbit inference engine (.agents/skills/review-doc-style/assets/nvidia-style-guide.md)

**/*.{md,mdx,rst}: For NeMo Fabric documentation, verify technical claims against the current repository, public API, or documented command before reviewing style.
Always spell NVIDIA in all caps; do not use Nvidia, nvidia, or NV.
Format commands, code elements, expressions, package names, file names, and paths as inline code.
Use descriptive link text; avoid raw URLs and weak anchors such as here or read more.
Use title case consistently for technical documentation headings.
Introduce code blocks, lists, tables, and images with complete sentences.
Write procedures as imperative, parallel steps; split long procedures into smaller tasks.
Prefer active voice, present tense, short sentences, contractions, and plain English while preserving necessary technical precision.
Use can for possibility and reserve may for permission.
Use after for temporal relationships instead of once, and prefer refer to over see when directing readers to another resource.
Avoid culture-specific idioms, unnecessary Latinisms, jokes, and marketing exaggeration in technical documentation.
Spell out months in body text, avoid ordinal dates, and use clear time zones.
Spell out whole numbers from zero through nine unless they are technical values, parameters, versions, or UI values; use numerals for 10 or greater and commas in thousands.
Do not add trademark symbols to learning-oriented documentation unless the source, platform, or legal guidance explicitly requires them.
Do not replace precise technical terms with simpler words when doing so would lose precision.
Do not flag passive voice when the actor is unknown or the action is the important part.
Do not rewrite API names, package names, command flags, or code literals for style.

**/*.{md,mdx,rst}: Use consistent title case for technical-document headings and table headers; avoid quotation marks, ampersands, and exclamation marks in headings, while preserving official product, event, research, and whitepaper title ...

Files:

• docs/reference/api/python-library-reference/nemo_fabric.runtime.md
• docs/reference/api/python-library-reference/nemo_fabric.client.md
• docs/reference/api/python-library-reference/nemo_fabric.errors.md
• docs/reference/api/python-library-reference/nemo_fabric.types.md
• docs/reference/api/python-library-reference/nemo_fabric.models.md

📄 CodeRabbit inference engine (.agents/skills/review-doc-style/assets/nvidia-style-language-mechanics.md)

**/*.{md,rst,txt,adoc}: For technical documentation, use professional, active, conversational, engaging, precise, and plain-English prose. Prefer active voice, present tense, short sentences, and scannable paragraphs. Avoid casual or imprecise language, swearing, threats, insults, jokes, puns, culture-specific idioms, marketing exaggeration, and unsupported third-party comparisons.
Use can for possibility and reserve may for permission; use after for temporal order; use refer to for cross-references; prefer short direct sentences and specific verbs; avoid unnecessary please in technical documentation.
Prefer active voice when the actor matters. Passive voice is acceptable when the actor is unknown or irrelevant, when the action or result is the focus, or in programmer documentation.
Use natural contractions in conversational technical prose, but do not force them in formal legal copy, API references, or generated text.
Prefer simpler English over Latinisms: use for example or such as instead of e.g., and so on instead of etc., that is instead of i.e., compared to instead of vs., and by, through, or using instead of via. Use industry-standard terms such as in silico, in vitro, and in vivo when appropriate, and italicize them in running text.
Use that without commas for essential clauses, and which with commas for nonessential clauses.
Format dates and times clearly: spell out months in body text; use forms such as June 12, 2025; avoid numeric or ordinal dates; capitalize days; use 12-hour time when appropriate; include a space before a.m. or p.m.; use ET and PT for needed time zones; avoid 24/7; and prefer from 12:30 to 1:00 p.m. for prose ranges.
Format numbers consistently: spell out zero through nine in body text, use numerals for 10 or greater and for technical values, use commas in thousands, do not begin a sentence with a numeral, spell out ordinals, and use numerals consistently within a category wh...

Files:

• docs/reference/api/python-library-reference/nemo_fabric.runtime.md
• docs/reference/api/python-library-reference/nemo_fabric.client.md
• docs/reference/api/python-library-reference/nemo_fabric.errors.md
• docs/reference/api/python-library-reference/nemo_fabric.types.md
• docs/reference/api/python-library-reference/nemo_fabric.models.md

📄 CodeRabbit inference engine (AGENTS.md)

Update Fern documentation under docs/ when public behavior, the nemo-fabric package, examples, or supported bindings change.

Files:

• docs/reference/api/python-library-reference/nemo_fabric.runtime.md
• docs/reference/api/python-library-reference/nemo_fabric.client.md
• docs/reference/api/python-library-reference/nemo_fabric.errors.md
• docs/reference/api/python-library-reference/nemo_fabric.types.md
• docs/reference/api/python-library-reference/nemo_fabric.models.md

📄 CodeRabbit inference engine (AGENTS.md)

Regenerate or update generated API references under docs/reference/api/ when the public API changes.

Treat all files under docs/reference/api/ as generated output and do not modify them directly.

Files:

• docs/reference/api/python-library-reference/nemo_fabric.runtime.md
• docs/reference/api/python-library-reference/nemo_fabric.client.md
• docs/reference/api/python-library-reference/nemo_fabric.errors.md
• docs/reference/api/python-library-reference/nemo_fabric.types.md
• docs/reference/api/python-library-reference/nemo_fabric.models.md

📄 CodeRabbit inference engine (.agents/skills/review-doc-style/SKILL.md)

**/*.{md,mdx}: Use the full product name NVIDIA NeMo Fabric on its first usage, typically in the title or H1; use NeMo Fabric thereafter.
Use fabric by itself only when referring to the CLI tool, and surround those references with backticks.
Capitalize NVIDIA correctly in public documentation.
Format commands, code elements, expressions, file names, paths, and filenames as inline code where needed.
Use title case consistently for headings in technical documentation.
Introduce code blocks, tables, and lists with complete lead-in sentences.
Use descriptive anchor text instead of raw URLs or generic link text such as here.
Prefer active voice, present tense, short sentences, and plain English.
Use consistent terminology for the same concept throughout a document.
Write procedures as imperative, parallel, easy-to-scan steps, and split long sequences into smaller tasks.
Use after instead of once when expressing temporal sequence.
Use can instead of may when the intended meaning is possibility rather than permission.
Avoid ambiguous numeric dates and ordinal dates in body text.
For learning-oriented documentation, do not force trademark symbols unless the source document explicitly requires them.
Introduce examples' code blocks with full sentences and ensure examples match current APIs and build commands.

For docs site changes, run just docs to regenerate Python and Rust API references and validate the Fern configuration.

Files:

• docs/reference/api/python-library-reference/nemo_fabric.runtime.md
• docs/reference/api/python-library-reference/nemo_fabric.client.md
• docs/reference/api/python-library-reference/nemo_fabric.errors.md
• docs/reference/api/python-library-reference/nemo_fabric.types.md
• docs/reference/api/python-library-reference/nemo_fabric.models.md

📄 CodeRabbit inference engine (CONTRIBUTING.md)

All Rust, Python, HTML, Markdown, MDX, TOML, YAML, and shell source files must include the project SPDX copyright and Apache-2.0 license headers using the comment syntax appropriate to each file type.

Files:

• docs/reference/api/python-library-reference/nemo_fabric.runtime.md
• scripts/docs/enhance_python_api_reference.py
• tests/docs/test_python_api_docs.py
• docs/reference/api/python-library-reference/nemo_fabric.client.md
• docs/reference/api/python-library-reference/nemo_fabric.errors.md
• docs/reference/api/python-library-reference/nemo_fabric.types.md
• docs/reference/api/python-library-reference/nemo_fabric.models.md

📄 CodeRabbit inference engine (CONTRIBUTING.md)

Update relevant documentation when changes affect public behavior, adapters, examples, or workspace structure.

Files:

• docs/reference/api/python-library-reference/nemo_fabric.runtime.md
• docs/reference/api/python-library-reference/nemo_fabric.client.md
• docs/reference/api/python-library-reference/nemo_fabric.errors.md
• docs/reference/api/python-library-reference/nemo_fabric.types.md
• docs/reference/api/python-library-reference/nemo_fabric.models.md

📄 CodeRabbit inference engine (.agents/skills/README.md)

Documentation and examples must be updated consistently with changes to public behavior and reviewed for NVIDIA technical-writing style.

Files:

• docs/reference/api/python-library-reference/nemo_fabric.runtime.md
• docs/reference/api/python-library-reference/nemo_fabric.client.md
• docs/reference/api/python-library-reference/nemo_fabric.errors.md
• docs/reference/api/python-library-reference/nemo_fabric.types.md
• docs/reference/api/python-library-reference/nemo_fabric.models.md

⚙️ CodeRabbit configuration file

{docs/**,README.md,AGENTS.md}: Review documentation for technical accuracy against the current API, command correctness, and consistency with generated schemas.

Files:

• docs/reference/api/python-library-reference/nemo_fabric.runtime.md
• docs/reference/api/python-library-reference/nemo_fabric.client.md
• docs/reference/api/python-library-reference/nemo_fabric.errors.md
• docs/reference/api/python-library-reference/nemo_fabric.types.md
• docs/reference/api/python-library-reference/nemo_fabric.models.md

⚙️ CodeRabbit configuration file

{*.md,**/*.md,**/*.mdx,**/*.ipynb}: Enforce the product name in user-facing prose: use "NVIDIA NeMo Fabric" on first use and "NeMo Fabric" thereafter. Flag standalone capitalized "Fabric" when it refers to the product. Do not flag the lowercase fabric CLI command, package/import/crate names, code identifiers, API symbols, configuration keys, file paths, or unrelated generic uses of the word.

Files:

• docs/reference/api/python-library-reference/nemo_fabric.runtime.md
• docs/reference/api/python-library-reference/nemo_fabric.client.md
• docs/reference/api/python-library-reference/nemo_fabric.errors.md
• docs/reference/api/python-library-reference/nemo_fabric.types.md
• docs/reference/api/python-library-reference/nemo_fabric.models.md

📄 CodeRabbit inference engine (.agents/skills/contribute-api/SKILL.md)

Determine and update every affected public surface, including the CLI, PyO3 bindings, Python SDK, type stubs, schemas, and adapter contract, so they remain in parity.

Files:

• scripts/docs/enhance_python_api_reference.py
• tests/docs/test_python_api_docs.py

📄 CodeRabbit inference engine (.agents/skills/prepare-pr/SKILL.md)

For native binding changes, run cargo check -p fabric-python --locked.

**/*.{rs,py}: When changing the Rust core or public schemas, run both the Rust and Python test suites.
When adding functionality, include tests in the corresponding Rust crate or the relevant area under tests/.

Files:

• scripts/docs/enhance_python_api_reference.py
• tests/docs/test_python_api_docs.py

📄 CodeRabbit inference engine (.agents/skills/validate-change/SKILL.md)

If Python code or a Python-facing adapter changes, run just test-python.

Files:

• scripts/docs/enhance_python_api_reference.py
• tests/docs/test_python_api_docs.py

📄 CodeRabbit inference engine (.agents/skills/validate-change/SKILL.md)

**/*.{rs,py,pyi}: If public configuration types change, confirm schema snapshot tests in just test-rust pass and review generated schema diffs.
For schema or public contract changes, run both language suites and review changes under schemas/ and generated API references.

Files:

• scripts/docs/enhance_python_api_reference.py
• tests/docs/test_python_api_docs.py

📄 CodeRabbit inference engine (.agents/skills/validate-change/SKILL.md)

For Python SDK or PyO3 binding changes, use python-tests, run focused pytest tests first, then just test-python; rebuild with just build-python when native code or packaging changes.

Files:

• scripts/docs/enhance_python_api_reference.py
• tests/docs/test_python_api_docs.py

📄 CodeRabbit inference engine (.agents/skills/update-project-version/SKILL.md)

When editing version helpers, verify every nemo-fabric-* workspace package through Cargo metadata and reject a static version in python/pyproject.toml.

Files:

• scripts/docs/enhance_python_api_reference.py
• tests/docs/test_python_api_docs.py

📄 CodeRabbit inference engine (.agents/skills/update-project-version/SKILL.md)

Avoid blind repository-wide replacement of version-like strings; distinguish package-version references from examples and unrelated dependency versions.

Files:

• scripts/docs/enhance_python_api_reference.py
• tests/docs/test_python_api_docs.py

📄 CodeRabbit inference engine (CONTRIBUTING.md)

Use type annotations for public Python APIs.

Files:

• scripts/docs/enhance_python_api_reference.py
• tests/docs/test_python_api_docs.py

📄 CodeRabbit inference engine (CONTRIBUTING.md)

**/*.{py,rs}: Keep native Python binding declarations synchronized with their Rust implementations.
Use snake_case for functions and variables; use PascalCase for Rust types and Python classes.

Files:

• scripts/docs/enhance_python_api_reference.py
• tests/docs/test_python_api_docs.py

📄 CodeRabbit inference engine (.agents/skills/python-tests/SKILL.md)

tests/**/*.py: Use Pytest to run Python tests.
Do not add @pytest.mark.asyncio to tests; async tests are automatically detected and run by the async runner.
Do not add -> None return type annotations to test functions.
When mocking a class, use unittest.mock.MagicMock or unittest.mock.AsyncMock, using the spec argument when necessary, rather than defining a new class.
Prefix mocked class names with mock, not fake.
Prefer pytest fixtures over helper methods.
Do not repeat fixtures; place fixtures needed by multiple test files in conftest.py.
Define fixtures using @pytest.fixture(name="<fixture_name>"[, scope="<scope>"]) and a function named <fixture_name>_fixture; specify scope only when it is not function.
Prefer pytest.mark.parametrize over separate tests for different input types.
Use @pytest.mark.usefixtures when a fixture is needed but its return value is unused or it does not return a value.
Use the autouse restore_environ_fixture from tests/conftest.py to restore environment variables; modify variables with os.environ and do not use monkeypatch.setenv.
Avoid defensive programming in tests; access expected data directly so missing data raises a clear failure, such as using results["data"] instead of results.get("data").

Files:

• tests/docs/test_python_api_docs.py

⚙️ CodeRabbit configuration file

{tests/**,python/tests/**}: Tests should cover the behavior promised by the changed API surface, including error paths, lifecycle cleanup, and SDK/native parity where relevant.

Files:

• tests/docs/test_python_api_docs.py

📄 CodeRabbit inference engine (.agents/skills/contribute-docs/SKILL.md)

Keep package names, repository references, and build commands current in documentation and examples.

Files:

• docs/getting-started/install.mdx
• docs/reference/api/python-library-reference/nemo_fabric.streaming.md
• docs/reference/api/python-library-reference/nemo_fabric.runtime.md
• docs/sdk/python.mdx
• docs/integrations/harness/codex.mdx
• docs/reference/api/python-library-reference/nemo_fabric.errors.md
• docs/reference/api/python-library-reference/nemo_fabric.client.md
• docs/reference/api/python-library-reference/nemo_fabric.types.md
• docs/reference/api/python-library-reference/nemo_fabric.models.md

📄 CodeRabbit inference engine (.agents/skills/contribute-docs/SKILL.md)

Update relevant getting-started, reference, adapter, and example documentation when the corresponding examples or adapters change.

Files:

• docs/getting-started/install.mdx
• docs/reference/api/python-library-reference/nemo_fabric.streaming.md
• docs/reference/api/python-library-reference/nemo_fabric.runtime.md
• docs/sdk/python.mdx
• docs/integrations/harness/codex.mdx
• docs/reference/api/python-library-reference/nemo_fabric.errors.md
• docs/reference/api/python-library-reference/nemo_fabric.client.md
• docs/reference/api/python-library-reference/nemo_fabric.types.md
• docs/reference/api/python-library-reference/nemo_fabric.models.md

📄 CodeRabbit inference engine (.agents/skills/contribute-docs/SKILL.md)

In MDX files, use JSX comment delimiters ({/* and */}) for top-of-file comments, including SPDX headers; do not use HTML comments.

Use {/* ... */} delimiters for top-of-file MDX SPDX comments, not HTML comment delimiters.

Files:

• docs/getting-started/install.mdx
• docs/sdk/python.mdx
• docs/integrations/harness/codex.mdx

📄 CodeRabbit inference engine (.agents/skills/contribute-docs/SKILL.md)

Run just docs when the documentation site changes.

Files:

• docs/getting-started/install.mdx
• docs/reference/api/python-library-reference/nemo_fabric.streaming.md
• docs/reference/api/python-library-reference/nemo_fabric.runtime.md
• docs/sdk/python.mdx
• docs/integrations/harness/codex.mdx
• docs/reference/api/python-library-reference/nemo_fabric.errors.md
• docs/reference/api/python-library-reference/nemo_fabric.client.md
• docs/reference/api/python-library-reference/nemo_fabric.types.md
• docs/reference/api/python-library-reference/nemo_fabric.models.md

📄 CodeRabbit inference engine (.agents/skills/karpathy-guidelines/SKILL.md)

**/*: Before implementing, explicitly state assumptions, surface ambiguity and tradeoffs, present multiple interpretations when relevant, and ask for clarification rather than silently deciding or proceeding when requirements are unclear.
Prefer the minimum code needed to solve the requested problem: avoid speculative features, unnecessary abstractions, unrequested flexibility, and handling of impossible scenarios; simplify overcomplicated solutions.
When editing existing code, make surgical changes only: do not modify unrelated code, comments, formatting, or pre-existing dead code; match the existing style, and remove only unused imports, variables, or functions introduced by your changes.
Define verifiable success criteria for each task, such as writing regression tests for bugs and invalid-input tests for validation, then verify the implementation against those criteria. For multi-step work, state a brief plan with a verification check for each step.

**/*: Always spell NVIDIA in all caps; do not use Nvidia, nvidia, nVidia, nVIDIA, or NV.
Use an NVIDIA before a noun, because the name begins with an “en” sound.
Do not add a registered trademark symbol after NVIDIA when referring to the company; use trademark symbols with product names only when required by the document type or legal guidance.
Verify official capitalization, spacing, hyphenation, and spelling for NVIDIA and third-party product names; do not rewrite official product names for grammar or title-case rules.
Precede NVIDIA product names with NVIDIA on first mention when natural and accurate, and link the first mention when the destination helps the reader.
On first use, include the company name and full model qualifier when it helps identify the model; preserve official capitalization and punctuation, and use shorter family names only after establishing the full name.
For learning-oriented and developer content, do not force trademark symbols unless explicitly required; for press, ...

Files:

• docs/getting-started/install.mdx
• docs/reference/api/python-library-reference/nemo_fabric.streaming.md
• scripts/generate_api_docs.sh
• python/src/nemo_fabric/types.py
• tests/e2e/test_cli_scaffold.py
• docs/reference/api/python-library-reference/nemo_fabric.runtime.md
• docs/sdk/python.mdx
• scripts/docs/enhance_python_api_reference.py
• skills/integrations/consumer/nemo-fabric-integrate/references/sdk-api-inventory.md
• docs/integrations/harness/codex.mdx
• crates/fabric-cli/src/scaffold.rs
• docs/reference/api/python-library-reference/nemo_fabric.errors.md
• docs/reference/api/python-library-reference/nemo_fabric.client.md
• tests/docs/test_python_api_docs.py
• docs/reference/api/python-library-reference/nemo_fabric.types.md
• docs/reference/api/python-library-reference/nemo_fabric.models.md

📄 CodeRabbit inference engine (.agents/skills/review-doc-style/assets/nvidia-style-guide.md)

**/*.{md,mdx,rst}: For NeMo Fabric documentation, verify technical claims against the current repository, public API, or documented command before reviewing style.
Always spell NVIDIA in all caps; do not use Nvidia, nvidia, or NV.
Format commands, code elements, expressions, package names, file names, and paths as inline code.
Use descriptive link text; avoid raw URLs and weak anchors such as here or read more.
Use title case consistently for technical documentation headings.
Introduce code blocks, lists, tables, and images with complete sentences.
Write procedures as imperative, parallel steps; split long procedures into smaller tasks.
Prefer active voice, present tense, short sentences, contractions, and plain English while preserving necessary technical precision.
Use can for possibility and reserve may for permission.
Use after for temporal relationships instead of once, and prefer refer to over see when directing readers to another resource.
Avoid culture-specific idioms, unnecessary Latinisms, jokes, and marketing exaggeration in technical documentation.
Spell out months in body text, avoid ordinal dates, and use clear time zones.
Spell out whole numbers from zero through nine unless they are technical values, parameters, versions, or UI values; use numerals for 10 or greater and commas in thousands.
Do not add trademark symbols to learning-oriented documentation unless the source, platform, or legal guidance explicitly requires them.
Do not replace precise technical terms with simpler words when doing so would lose precision.
Do not flag passive voice when the actor is unknown or the action is the important part.
Do not rewrite API names, package names, command flags, or code literals for style.

**/*.{md,mdx,rst}: Use consistent title case for technical-document headings and table headers; avoid quotation marks, ampersands, and exclamation marks in headings, while preserving official product, event, research, and whitepaper title ...

Files:

• docs/getting-started/install.mdx
• docs/reference/api/python-library-reference/nemo_fabric.streaming.md
• docs/reference/api/python-library-reference/nemo_fabric.runtime.md
• docs/sdk/python.mdx
• skills/integrations/consumer/nemo-fabric-integrate/references/sdk-api-inventory.md
• docs/integrations/harness/codex.mdx
• docs/reference/api/python-library-reference/nemo_fabric.errors.md
• docs/reference/api/python-library-reference/nemo_fabric.client.md
• docs/reference/api/python-library-reference/nemo_fabric.types.md
• docs/reference/api/python-library-reference/nemo_fabric.models.md

📄 CodeRabbit inference engine (AGENTS.md)

Update Fern documentation under docs/ when public behavior, the nemo-fabric package, examples, or supported bindings change.

Files:

• docs/getting-started/install.mdx
• docs/reference/api/python-library-reference/nemo_fabric.streaming.md
• docs/reference/api/python-library-reference/nemo_fabric.runtime.md
• docs/sdk/python.mdx
• docs/integrations/harness/codex.mdx
• docs/reference/api/python-library-reference/nemo_fabric.errors.md
• docs/reference/api/python-library-reference/nemo_fabric.client.md
• docs/reference/api/python-library-reference/nemo_fabric.types.md
• docs/reference/api/python-library-reference/nemo_fabric.models.md

📄 CodeRabbit inference engine (.agents/skills/review-doc-style/SKILL.md)

**/*.{md,mdx}: Use the full product name NVIDIA NeMo Fabric on its first usage, typically in the title or H1; use NeMo Fabric thereafter.
Use fabric by itself only when referring to the CLI tool, and surround those references with backticks.
Capitalize NVIDIA correctly in public documentation.
Format commands, code elements, expressions, file names, paths, and filenames as inline code where needed.
Use title case consistently for headings in technical documentation.
Introduce code blocks, tables, and lists with complete lead-in sentences.
Use descriptive anchor text instead of raw URLs or generic link text such as here.
Prefer active voice, present tense, short sentences, and plain English.
Use consistent terminology for the same concept throughout a document.
Write procedures as imperative, parallel, easy-to-scan steps, and split long sequences into smaller tasks.
Use after instead of once when expressing temporal sequence.
Use can instead of may when the intended meaning is possibility rather than permission.
Avoid ambiguous numeric dates and ordinal dates in body text.
For learning-oriented documentation, do not force trademark symbols unless the source document explicitly requires them.
Introduce examples' code blocks with full sentences and ensure examples match current APIs and build commands.

For docs site changes, run just docs to regenerate Python and Rust API references and validate the Fern configuration.

Files:

• docs/getting-started/install.mdx
• docs/reference/api/python-library-reference/nemo_fabric.streaming.md
• docs/reference/api/python-library-reference/nemo_fabric.runtime.md
• docs/sdk/python.mdx
• skills/integrations/consumer/nemo-fabric-integrate/references/sdk-api-inventory.md
• docs/integrations/harness/codex.mdx
• docs/reference/api/python-library-reference/nemo_fabric.errors.md
• docs/reference/api/python-library-reference/nemo_fabric.client.md
• docs/reference/api/python-library-reference/nemo_fabric.types.md
• docs/reference/api/python-library-reference/nemo_fabric.models.md

📄 CodeRabbit inference engine (CONTRIBUTING.md)

All Rust, Python, HTML, Markdown, MDX, TOML, YAML, and shell source files must include the project SPDX copyright and Apache-2.0 license headers using the comment syntax appropriate to each file type.

Files:

• docs/getting-started/install.mdx
• docs/reference/api/python-library-reference/nemo_fabric.streaming.md
• scripts/generate_api_docs.sh
• python/src/nemo_fabric/types.py
• tests/e2e/test_cli_scaffold.py
• docs/reference/api/python-library-reference/nemo_fabric.runtime.md
• docs/sdk/python.mdx
• scripts/docs/enhance_python_api_reference.py
• skills/integrations/consumer/nemo-fabric-integrate/references/sdk-api-inventory.md
• docs/integrations/harness/codex.mdx
• crates/fabric-cli/src/scaffold.rs
• docs/reference/api/python-library-reference/nemo_fabric.errors.md
• docs/reference/api/python-library-reference/nemo_fabric.client.md
• tests/docs/test_python_api_docs.py
• docs/reference/api/python-library-reference/nemo_fabric.types.md
• docs/reference/api/python-library-reference/nemo_fabric.models.md

📄 CodeRabbit inference engine (CONTRIBUTING.md)

Update relevant documentation when changes affect public behavior, adapters, examples, or workspace structure.

Files:

• docs/getting-started/install.mdx
• docs/reference/api/python-library-reference/nemo_fabric.streaming.md
• docs/reference/api/python-library-reference/nemo_fabric.runtime.md
• docs/sdk/python.mdx
• skills/integrations/consumer/nemo-fabric-integrate/references/sdk-api-inventory.md
• docs/integrations/harness/codex.mdx
• docs/reference/api/python-library-reference/nemo_fabric.errors.md
• docs/reference/api/python-library-reference/nemo_fabric.client.md
• docs/reference/api/python-library-reference/nemo_fabric.types.md
• docs/reference/api/python-library-reference/nemo_fabric.models.md

⚙️ CodeRabbit configuration file

{docs/**,README.md,AGENTS.md}: Review documentation for technical accuracy against the current API, command correctness, and consistency with generated schemas.
For links between files under docs/, require paths relative to the source file with the target file's .mdx extension so they work in both Fern builds and repository browsers. Flag Fern site-root links such as NeMo Fabric overview; use the repository-relative equivalent, such as NeMo Fabric overview.

Files:

• docs/getting-started/install.mdx
• docs/reference/api/python-library-reference/nemo_fabric.streaming.md
• docs/reference/api/python-library-reference/nemo_fabric.runtime.md
• docs/sdk/python.mdx
• docs/integrations/harness/codex.mdx
• docs/reference/api/python-library-reference/nemo_fabric.errors.md
• docs/reference/api/python-library-reference/nemo_fabric.client.md
• docs/reference/api/python-library-reference/nemo_fabric.types.md
• docs/reference/api/python-library-reference/nemo_fabric.models.md

⚙️ CodeRabbit configuration file

{*.md,**/*.md,**/*.mdx,**/*.ipynb}: Enforce the product name in user-facing prose: use "NVIDIA NeMo Fabric" on first use and "NeMo Fabric" thereafter. Flag standalone capitalized "Fabric" when it refers to the product. Do not flag the lowercase fabric CLI command, package/import/crate names, code identifiers, API symbols, configuration keys, file paths, or unrelated generic uses of the word.

Files:

• docs/getting-started/install.mdx
• docs/reference/api/python-library-reference/nemo_fabric.streaming.md
• docs/reference/api/python-library-reference/nemo_fabric.runtime.md
• docs/sdk/python.mdx
• skills/integrations/consumer/nemo-fabric-integrate/references/sdk-api-inventory.md
• docs/integrations/harness/codex.mdx
• docs/reference/api/python-library-reference/nemo_fabric.errors.md
• docs/reference/api/python-library-reference/nemo_fabric.client.md
• docs/reference/api/python-library-reference/nemo_fabric.types.md
• docs/reference/api/python-library-reference/nemo_fabric.models.md

📄 CodeRabbit inference engine (.agents/skills/contribute-api/SKILL.md)

Update documentation and examples in the same branch as the public API change.

Files:

• docs/reference/api/python-library-reference/nemo_fabric.streaming.md
• docs/reference/api/python-library-reference/nemo_fabric.runtime.md
• skills/integrations/consumer/nemo-fabric-integrate/references/sdk-api-inventory.md
• docs/reference/api/python-library-reference/nemo_fabric.errors.md
• docs/reference/api/python-library-reference/nemo_fabric.client.md
• docs/reference/api/python-library-reference/nemo_fabric.types.md
• docs/reference/api/python-library-reference/nemo_fabric.models.md

📄 CodeRabbit inference engine (.agents/skills/review-doc-style/assets/nvidia-style-language-mechanics.md)

**/*.{md,rst,txt,adoc}: For technical documentation, use professional, active, conversational, engaging, precise, and plain-English prose. Prefer active voice, present tense, short sentences, and scannable paragraphs. Avoid casual or imprecise language, swearing, threats, insults, jokes, puns, culture-specific idioms, marketing exaggeration, and unsupported third-party comparisons.
Use can for possibility and reserve may for permission; use after for temporal order; use refer to for cross-references; prefer short direct sentences and specific verbs; avoid unnecessary please in technical documentation.
Prefer active voice when the actor matters. Passive voice is acceptable when the actor is unknown or irrelevant, when the action or result is the focus, or in programmer documentation.
Use natural contractions in conversational technical prose, but do not force them in formal legal copy, API references, or generated text.
Prefer simpler English over Latinisms: use for example or such as instead of e.g., and so on instead of etc., that is instead of i.e., compared to instead of vs., and by, through, or using instead of via. Use industry-standard terms such as in silico, in vitro, and in vivo when appropriate, and italicize them in running text.
Use that without commas for essential clauses, and which with commas for nonessential clauses.
Format dates and times clearly: spell out months in body text; use forms such as June 12, 2025; avoid numeric or ordinal dates; capitalize days; use 12-hour time when appropriate; include a space before a.m. or p.m.; use ET and PT for needed time zones; avoid 24/7; and prefer from 12:30 to 1:00 p.m. for prose ranges.
Format numbers consistently: spell out zero through nine in body text, use numerals for 10 or greater and for technical values, use commas in thousands, do not begin a sentence with a numeral, spell out ordinals, and use numerals consistently within a category wh...

Files:

• docs/reference/api/python-library-reference/nemo_fabric.streaming.md
• docs/reference/api/python-library-reference/nemo_fabric.runtime.md
• skills/integrations/consumer/nemo-fabric-integrate/references/sdk-api-inventory.md
• docs/reference/api/python-library-reference/nemo_fabric.errors.md
• docs/reference/api/python-library-reference/nemo_fabric.client.md
• docs/reference/api/python-library-reference/nemo_fabric.types.md
• docs/reference/api/python-library-reference/nemo_fabric.models.md

📄 CodeRabbit inference engine (AGENTS.md)

Regenerate or update generated API references under docs/reference/api/ when the public API changes.

Treat all files under docs/reference/api/ as generated output and do not modify them directly.

Files:

• docs/reference/api/python-library-reference/nemo_fabric.streaming.md
• docs/reference/api/python-library-reference/nemo_fabric.runtime.md
• docs/reference/api/python-library-reference/nemo_fabric.errors.md
• docs/reference/api/python-library-reference/nemo_fabric.client.md
• docs/reference/api/python-library-reference/nemo_fabric.types.md
• docs/reference/api/python-library-reference/nemo_fabric.models.md

📄 CodeRabbit inference engine (.agents/skills/README.md)

Documentation and examples must be updated consistently with changes to public behavior and reviewed for NVIDIA technical-writing style.

Files:

• docs/reference/api/python-library-reference/nemo_fabric.streaming.md
• docs/reference/api/python-library-reference/nemo_fabric.runtime.md
• skills/integrations/consumer/nemo-fabric-integrate/references/sdk-api-inventory.md
• docs/reference/api/python-library-reference/nemo_fabric.errors.md
• docs/reference/api/python-library-reference/nemo_fabric.client.md
• docs/reference/api/python-library-reference/nemo_fabric.types.md
• docs/reference/api/python-library-reference/nemo_fabric.models.md

📄 CodeRabbit inference engine (AGENTS.md)

Keep the stable public wrapper scripts/generate_api_docs.sh at the scripts/ root and reference it in docs and examples; use namespaced paths under scripts/docs/ only for internal maintenance documentation.

For Python API reference changes, update scripts/generate_api_docs.sh when the generator itself requires changes.

Files:

• scripts/generate_api_docs.sh

📄 CodeRabbit inference engine (.agents/skills/contribute-api/SKILL.md)

Determine and update every affected public surface, including the CLI, PyO3 bindings, Python SDK, type stubs, schemas, and adapter contract, so they remain in parity.

Files:

• python/src/nemo_fabric/types.py
• tests/e2e/test_cli_scaffold.py
• scripts/docs/enhance_python_api_reference.py
• crates/fabric-cli/src/scaffold.rs
• tests/docs/test_python_api_docs.py

📄 CodeRabbit inference engine (.agents/skills/maintain-packaging/SKILL.md)

Ensure the editable maturin build continues to produce the native extension at nemo_fabric._native, with generated artifacts placed where downstream consumers expect.

Files:

• python/src/nemo_fabric/types.py

📄 CodeRabbit inference engine (.agents/skills/prepare-pr/SKILL.md)

For native binding changes, run cargo check -p fabric-python --locked.

**/*.{rs,py}: When changing the Rust core or public schemas, run both the Rust and Python test suites.
When adding functionality, include tests in the corresponding Rust crate or the relevant area under tests/.

Files:

• python/src/nemo_fabric/types.py
• tests/e2e/test_cli_scaffold.py
• scripts/docs/enhance_python_api_reference.py
• crates/fabric-cli/src/scaffold.rs
• tests/docs/test_python_api_docs.py

📄 CodeRabbit inference engine (.agents/skills/review-doc-style/SKILL.md)

For Python API reference changes, update source docstrings under python/src/nemo_fabric/ instead of editing generated reference output.

Files:

• python/src/nemo_fabric/types.py

📄 CodeRabbit inference engine (.agents/skills/validate-change/SKILL.md)

If Python code or a Python-facing adapter changes, run just test-python.

Files:

• python/src/nemo_fabric/types.py
• tests/e2e/test_cli_scaffold.py
• scripts/docs/enhance_python_api_reference.py
• tests/docs/test_python_api_docs.py

📄 CodeRabbit inference engine (.agents/skills/validate-change/SKILL.md)

**/*.{rs,py,pyi}: If public configuration types change, confirm schema snapshot tests in just test-rust pass and review generated schema diffs.
For schema or public contract changes, run both language suites and review changes under schemas/ and generated API references.

Files:

• python/src/nemo_fabric/types.py
• tests/e2e/test_cli_scaffold.py
• scripts/docs/enhance_python_api_reference.py
• crates/fabric-cli/src/scaffold.rs
• tests/docs/test_python_api_docs.py

📄 CodeRabbit inference engine (.agents/skills/validate-change/SKILL.md)

For Python SDK or PyO3 binding changes, use python-tests, run focused pytest tests first, then just test-python; rebuild with just build-python when native code or packaging changes.

Files:

• python/src/nemo_fabric/types.py
• tests/e2e/test_cli_scaffold.py
• scripts/docs/enhance_python_api_reference.py
• crates/fabric-cli/src/scaffold.rs
• tests/docs/test_python_api_docs.py

📄 CodeRabbit inference engine (.agents/skills/update-project-version/SKILL.md)

When editing version helpers, verify every nemo-fabric-* workspace package through Cargo metadata and reject a static version in python/pyproject.toml.

Files:

• python/src/nemo_fabric/types.py
• tests/e2e/test_cli_scaffold.py
• scripts/docs/enhance_python_api_reference.py
• crates/fabric-cli/src/scaffold.rs
• tests/docs/test_python_api_docs.py

📄 CodeRabbit inference engine (.agents/skills/update-project-version/SKILL.md)

Avoid blind repository-wide replacement of version-like strings; distinguish package-version references from examples and unrelated dependency versions.

Files:

• python/src/nemo_fabric/types.py
• tests/e2e/test_cli_scaffold.py
• scripts/docs/enhance_python_api_reference.py
• crates/fabric-cli/src/scaffold.rs
• tests/docs/test_python_api_docs.py

📄 CodeRabbit inference engine (CONTRIBUTING.md)

Use type annotations for public Python APIs.

Files:

• python/src/nemo_fabric/types.py
• tests/e2e/test_cli_scaffold.py
• scripts/docs/enhance_python_api_reference.py
• tests/docs/test_python_api_docs.py

📄 CodeRabbit inference engine (CONTRIBUTING.md)

**/*.{py,rs}: Keep native Python binding declarations synchronized with their Rust implementations.
Use snake_case for functions and variables; use PascalCase for Rust types and Python classes.

Files:

• python/src/nemo_fabric/types.py
• tests/e2e/test_cli_scaffold.py
• scripts/docs/enhance_python_api_reference.py
• crates/fabric-cli/src/scaffold.rs
• tests/docs/test_python_api_docs.py

⚙️ CodeRabbit configuration file

python/src/nemo_fabric/**/*: Review Python SDK changes for typed API consistency, import-time dependency neutrality, async/session behavior, and parity with the native extension.
Stubs and runtime implementations should stay aligned.

Files:

• python/src/nemo_fabric/types.py

📄 CodeRabbit inference engine (.agents/skills/python-tests/SKILL.md)

tests/**/*.py: Use Pytest to run Python tests.
Do not add @pytest.mark.asyncio to tests; async tests are automatically detected and run by the async runner.
Do not add -> None return type annotations to test functions.
When mocking a class, use unittest.mock.MagicMock or unittest.mock.AsyncMock, using the spec argument when necessary, rather than defining a new class.
Prefix mocked class names with mock, not fake.
Prefer pytest fixtures over helper methods.
Do not repeat fixtures; place fixtures needed by multiple test files in conftest.py.
Define fixtures using @pytest.fixture(name="<fixture_name>"[, scope="<scope>"]) and a function named <fixture_name>_fixture; specify scope only when it is not function.
Prefer pytest.mark.parametrize over separate tests for different input types.
Use @pytest.mark.usefixtures when a fixture is needed but its return value is unused or it does not return a value.
Use the autouse restore_environ_fixture from tests/conftest.py to restore environment variables; modify variables with os.environ and do not use monkeypatch.setenv.
Avoid defensive programming in tests; access expected data directly so missing data raises a clear failure, such as using results["data"] instead of results.get("data").

Files:

• tests/e2e/test_cli_scaffold.py
• tests/docs/test_python_api_docs.py

⚙️ CodeRabbit configuration file

{tests/**,python/tests/**}: Tests should cover the behavior promised by the changed API surface, including error paths, lifecycle cleanup, and SDK/native parity where relevant.

Files:

• tests/e2e/test_cli_scaffold.py
• tests/docs/test_python_api_docs.py

📄 CodeRabbit inference engine (AGENTS.md)

Keep docs/sdk/python.mdx current when the public Python API changes.

Files:

• docs/sdk/python.mdx

📄 CodeRabbit inference engine (AGENTS.md)

skills/**: Keep consumer skills under skills/ self-contained and dependent only on supported public Python SDK contracts and published documentation; do not add repository-internal contribution guidance.
Keep consumer skills in parity with the public SDK guide, model, and type details when the Python/Rust binding contract changes.

Files:

• skills/integrations/consumer/nemo-fabric-integrate/references/sdk-api-inventory.md

📄 CodeRabbit inference engine (.agents/skills/contribute-api/SKILL.md)

Implement new runtime or binding behavior in the shared Rust core first.

**/*.rs: Format Rust code with cargo fmt --all; Rust formatting checks must pass with cargo fmt --all -- --check.
Rust workspace changes must pass cargo check --workspace --locked.

Files:

• crates/fabric-cli/src/scaffold.rs

📄 CodeRabbit inference engine (.agents/skills/prepare-pr/SKILL.md)

For any Rust change, run just test-rust and cargo fmt --all -- --check.

For Rust core, CLI, or shared runtime semantic changes, run Rust formatting and tests, and add Python tests when behavior is exposed through the SDK.

Files:

• crates/fabric-cli/src/scaffold.rs

📄 CodeRabbit inference engine (.agents/skills/validate-change/SKILL.md)

If Rust code changes, run cargo fmt --all -- --check and just test-rust.

Files:

• crates/fabric-cli/src/scaffold.rs

Learnt from: AjayThorve
Repo: NVIDIA/NeMo-Fabric PR: 26
File: python/tests/smoke_typed_config.py:163-177
Timestamp: 2026-06-28T04:03:32.877Z
Learning: In NVIDIA NeMo Fabric Python SDK serialization of `RuntimeCapabilities` (to satisfy the “parity contract” with Rust core and the CLI), do not emit metadata keys when the corresponding metadata is absent. Instead, omit those fields entirely so the produced JSON matches the Rust/CLI output (e.g., avoid `null`, empty objects, or placeholder metadata). During review, verify the serializer/builders follow this omission rule and that Python outputs/parity tests reflect the same shape.

Applied to files:

• python/src/nemo_fabric/types.py

[error] 175-178: The use of exec can be insecure
Context: exec(
f"from future import annotations\n{rendered}:\n pass\n",
namespace,
)
Note: [CWE-94] Improper Control of Generation of Code ('Code Injection').

(no-exec)

[warning] 9-9: Headings should be surrounded by blank lines
Expected: 1; Actual: 0; Below

(MD022, blanks-around-headings)

[warning] 17-17: Headings should be surrounded by blank lines
Expected: 1; Actual: 0; Below

(MD022, blanks-around-headings)

[error] 176-176: Use of exec detected

(S102)

📄 CodeRabbit inference engine (.agents/skills/contribute-api/SKILL.md)

Update documentation and examples in the same branch as the public API change.

Files:

• docs/reference/api/python-library-reference/nemo_fabric.streaming.md
• docs/reference/api/python-library-reference/nemo_fabric.client.md
• docs/reference/api/python-library-reference/nemo_fabric.runtime.md
• docs/reference/api/python-library-reference/nemo_fabric.errors.md
• docs/reference/api/python-library-reference/nemo_fabric.types.md
• docs/reference/api/python-library-reference/nemo_fabric.models.md

📄 CodeRabbit inference engine (.agents/skills/contribute-docs/SKILL.md)

Keep package names, repository references, and build commands current in documentation and examples.

Files:

• docs/reference/api/python-library-reference/nemo_fabric.streaming.md
• docs/reference/api/python-library-reference/nemo_fabric.client.md
• docs/reference/api/python-library-reference/nemo_fabric.runtime.md
• docs/reference/api/python-library-reference/nemo_fabric.errors.md
• docs/sdk/python.mdx
• docs/reference/api/python-library-reference/nemo_fabric.types.md
• docs/reference/api/python-library-reference/nemo_fabric.models.md

📄 CodeRabbit inference engine (.agents/skills/contribute-docs/SKILL.md)

Update relevant getting-started, reference, adapter, and example documentation when the corresponding examples or adapters change.

Files:

• docs/reference/api/python-library-reference/nemo_fabric.streaming.md
• docs/reference/api/python-library-reference/nemo_fabric.client.md
• docs/reference/api/python-library-reference/nemo_fabric.runtime.md
• docs/reference/api/python-library-reference/nemo_fabric.errors.md
• docs/sdk/python.mdx
• docs/reference/api/python-library-reference/nemo_fabric.types.md
• docs/reference/api/python-library-reference/nemo_fabric.models.md

📄 CodeRabbit inference engine (.agents/skills/contribute-docs/SKILL.md)

Run just docs when the documentation site changes.

Files:

• docs/reference/api/python-library-reference/nemo_fabric.streaming.md
• docs/reference/api/python-library-reference/nemo_fabric.client.md
• docs/reference/api/python-library-reference/nemo_fabric.runtime.md
• docs/reference/api/python-library-reference/nemo_fabric.errors.md
• docs/sdk/python.mdx
• docs/reference/api/python-library-reference/nemo_fabric.types.md
• docs/reference/api/python-library-reference/nemo_fabric.models.md

📄 CodeRabbit inference engine (.agents/skills/karpathy-guidelines/SKILL.md)

**/*: Before implementing, explicitly state assumptions, surface ambiguity and tradeoffs, present multiple interpretations when relevant, and ask for clarification rather than silently deciding or proceeding when requirements are unclear.
Prefer the minimum code needed to solve the requested problem: avoid speculative features, unnecessary abstractions, unrequested flexibility, and handling of impossible scenarios; simplify overcomplicated solutions.
When editing existing code, make surgical changes only: do not modify unrelated code, comments, formatting, or pre-existing dead code; match the existing style, and remove only unused imports, variables, or functions introduced by your changes.
Define verifiable success criteria for each task, such as writing regression tests for bugs and invalid-input tests for validation, then verify the implementation against those criteria. For multi-step work, state a brief plan with a verification check for each step.

**/*: Always spell NVIDIA in all caps; do not use Nvidia, nvidia, nVidia, nVIDIA, or NV.
Use an NVIDIA before a noun, because the name begins with an “en” sound.
Do not add a registered trademark symbol after NVIDIA when referring to the company; use trademark symbols with product names only when required by the document type or legal guidance.
Verify official capitalization, spacing, hyphenation, and spelling for NVIDIA and third-party product names; do not rewrite official product names for grammar or title-case rules.
Precede NVIDIA product names with NVIDIA on first mention when natural and accurate, and link the first mention when the destination helps the reader.
On first use, include the company name and full model qualifier when it helps identify the model; preserve official capitalization and punctuation, and use shorter family names only after establishing the full name.
For learning-oriented and developer content, do not force trademark symbols unless explicitly required; for press, ...

Files:

• docs/reference/api/python-library-reference/nemo_fabric.streaming.md
• scripts/generate_api_docs.sh
• tests/python/test_typed_config.py
• docs/reference/api/python-library-reference/nemo_fabric.client.md
• docs/reference/api/python-library-reference/nemo_fabric.runtime.md
• docs/reference/api/python-library-reference/nemo_fabric.errors.md
• docs/sdk/python.mdx
• tests/docs/test_python_api_docs.py
• docs/reference/api/python-library-reference/nemo_fabric.types.md
• docs/reference/api/python-library-reference/nemo_fabric.models.md

📄 CodeRabbit inference engine (.agents/skills/review-doc-style/assets/nvidia-style-guide.md)

**/*.{md,mdx,rst}: For NeMo Fabric documentation, verify technical claims against the current repository, public API, or documented command before reviewing style.
Always spell NVIDIA in all caps; do not use Nvidia, nvidia, or NV.
Format commands, code elements, expressions, package names, file names, and paths as inline code.
Use descriptive link text; avoid raw URLs and weak anchors such as here or read more.
Use title case consistently for technical documentation headings.
Introduce code blocks, lists, tables, and images with complete sentences.
Write procedures as imperative, parallel steps; split long procedures into smaller tasks.
Prefer active voice, present tense, short sentences, contractions, and plain English while preserving necessary technical precision.
Use can for possibility and reserve may for permission.
Use after for temporal relationships instead of once, and prefer refer to over see when directing readers to another resource.
Avoid culture-specific idioms, unnecessary Latinisms, jokes, and marketing exaggeration in technical documentation.
Spell out months in body text, avoid ordinal dates, and use clear time zones.
Spell out whole numbers from zero through nine unless they are technical values, parameters, versions, or UI values; use numerals for 10 or greater and commas in thousands.
Do not add trademark symbols to learning-oriented documentation unless the source, platform, or legal guidance explicitly requires them.
Do not replace precise technical terms with simpler words when doing so would lose precision.
Do not flag passive voice when the actor is unknown or the action is the important part.
Do not rewrite API names, package names, command flags, or code literals for style.

**/*.{md,mdx,rst}: Use consistent title case for technical-document headings and table headers; avoid quotation marks, ampersands, and exclamation marks in headings, while preserving official product, event, research, and whitepaper title ...

Files:

• docs/reference/api/python-library-reference/nemo_fabric.streaming.md
• docs/reference/api/python-library-reference/nemo_fabric.client.md
• docs/reference/api/python-library-reference/nemo_fabric.runtime.md
• docs/reference/api/python-library-reference/nemo_fabric.errors.md
• docs/sdk/python.mdx
• docs/reference/api/python-library-reference/nemo_fabric.types.md
• docs/reference/api/python-library-reference/nemo_fabric.models.md

📄 CodeRabbit inference engine (.agents/skills/review-doc-style/assets/nvidia-style-language-mechanics.md)

**/*.{md,rst,txt,adoc}: For technical documentation, use professional, active, conversational, engaging, precise, and plain-English prose. Prefer active voice, present tense, short sentences, and scannable paragraphs. Avoid casual or imprecise language, swearing, threats, insults, jokes, puns, culture-specific idioms, marketing exaggeration, and unsupported third-party comparisons.
Use can for possibility and reserve may for permission; use after for temporal order; use refer to for cross-references; prefer short direct sentences and specific verbs; avoid unnecessary please in technical documentation.
Prefer active voice when the actor matters. Passive voice is acceptable when the actor is unknown or irrelevant, when the action or result is the focus, or in programmer documentation.
Use natural contractions in conversational technical prose, but do not force them in formal legal copy, API references, or generated text.
Prefer simpler English over Latinisms: use for example or such as instead of e.g., and so on instead of etc., that is instead of i.e., compared to instead of vs., and by, through, or using instead of via. Use industry-standard terms such as in silico, in vitro, and in vivo when appropriate, and italicize them in running text.
Use that without commas for essential clauses, and which with commas for nonessential clauses.
Format dates and times clearly: spell out months in body text; use forms such as June 12, 2025; avoid numeric or ordinal dates; capitalize days; use 12-hour time when appropriate; include a space before a.m. or p.m.; use ET and PT for needed time zones; avoid 24/7; and prefer from 12:30 to 1:00 p.m. for prose ranges.
Format numbers consistently: spell out zero through nine in body text, use numerals for 10 or greater and for technical values, use commas in thousands, do not begin a sentence with a numeral, spell out ordinals, and use numerals consistently within a category wh...

Files:

• docs/reference/api/python-library-reference/nemo_fabric.streaming.md
• docs/reference/api/python-library-reference/nemo_fabric.client.md
• docs/reference/api/python-library-reference/nemo_fabric.runtime.md
• docs/reference/api/python-library-reference/nemo_fabric.errors.md
• docs/reference/api/python-library-reference/nemo_fabric.types.md
• docs/reference/api/python-library-reference/nemo_fabric.models.md

📄 CodeRabbit inference engine (AGENTS.md)

Update Fern documentation under docs/ when public behavior, the nemo-fabric package, examples, or supported bindings change.

Files:

• docs/reference/api/python-library-reference/nemo_fabric.streaming.md
• docs/reference/api/python-library-reference/nemo_fabric.client.md
• docs/reference/api/python-library-reference/nemo_fabric.runtime.md
• docs/reference/api/python-library-reference/nemo_fabric.errors.md
• docs/sdk/python.mdx
• docs/reference/api/python-library-reference/nemo_fabric.types.md
• docs/reference/api/python-library-reference/nemo_fabric.models.md

📄 CodeRabbit inference engine (AGENTS.md)

Regenerate or update generated API references under docs/reference/api/ when the public API changes.

Treat all files under docs/reference/api/ as generated output and do not modify them directly.

Files:

• docs/reference/api/python-library-reference/nemo_fabric.streaming.md
• docs/reference/api/python-library-reference/nemo_fabric.client.md
• docs/reference/api/python-library-reference/nemo_fabric.runtime.md
• docs/reference/api/python-library-reference/nemo_fabric.errors.md
• docs/reference/api/python-library-reference/nemo_fabric.types.md
• docs/reference/api/python-library-reference/nemo_fabric.models.md

📄 CodeRabbit inference engine (.agents/skills/review-doc-style/SKILL.md)

**/*.{md,mdx}: Use the full product name NVIDIA NeMo Fabric on its first usage, typically in the title or H1; use NeMo Fabric thereafter.
Use fabric by itself only when referring to the CLI tool, and surround those references with backticks.
Capitalize NVIDIA correctly in public documentation.
Format commands, code elements, expressions, file names, paths, and filenames as inline code where needed.
Use title case consistently for headings in technical documentation.
Introduce code blocks, tables, and lists with complete lead-in sentences.
Use descriptive anchor text instead of raw URLs or generic link text such as here.
Prefer active voice, present tense, short sentences, and plain English.
Use consistent terminology for the same concept throughout a document.
Write procedures as imperative, parallel, easy-to-scan steps, and split long sequences into smaller tasks.
Use after instead of once when expressing temporal sequence.
Use can instead of may when the intended meaning is possibility rather than permission.
Avoid ambiguous numeric dates and ordinal dates in body text.
For learning-oriented documentation, do not force trademark symbols unless the source document explicitly requires them.
Introduce examples' code blocks with full sentences and ensure examples match current APIs and build commands.

For docs site changes, run just docs to regenerate Python and Rust API references and validate the Fern configuration.

Files:

• docs/reference/api/python-library-reference/nemo_fabric.streaming.md
• docs/reference/api/python-library-reference/nemo_fabric.client.md
• docs/reference/api/python-library-reference/nemo_fabric.runtime.md
• docs/reference/api/python-library-reference/nemo_fabric.errors.md
• docs/sdk/python.mdx
• docs/reference/api/python-library-reference/nemo_fabric.types.md
• docs/reference/api/python-library-reference/nemo_fabric.models.md

📄 CodeRabbit inference engine (CONTRIBUTING.md)

All Rust, Python, HTML, Markdown, MDX, TOML, YAML, and shell source files must include the project SPDX copyright and Apache-2.0 license headers using the comment syntax appropriate to each file type.

Files:

• docs/reference/api/python-library-reference/nemo_fabric.streaming.md
• scripts/generate_api_docs.sh
• tests/python/test_typed_config.py
• docs/reference/api/python-library-reference/nemo_fabric.client.md
• docs/reference/api/python-library-reference/nemo_fabric.runtime.md
• docs/reference/api/python-library-reference/nemo_fabric.errors.md
• docs/sdk/python.mdx
• tests/docs/test_python_api_docs.py
• docs/reference/api/python-library-reference/nemo_fabric.types.md
• docs/reference/api/python-library-reference/nemo_fabric.models.md

📄 CodeRabbit inference engine (CONTRIBUTING.md)

Update relevant documentation when changes affect public behavior, adapters, examples, or workspace structure.

Files:

• docs/reference/api/python-library-reference/nemo_fabric.streaming.md
• docs/reference/api/python-library-reference/nemo_fabric.client.md
• docs/reference/api/python-library-reference/nemo_fabric.runtime.md
• docs/reference/api/python-library-reference/nemo_fabric.errors.md
• docs/sdk/python.mdx
• docs/reference/api/python-library-reference/nemo_fabric.types.md
• docs/reference/api/python-library-reference/nemo_fabric.models.md

📄 CodeRabbit inference engine (.agents/skills/README.md)

Documentation and examples must be updated consistently with changes to public behavior and reviewed for NVIDIA technical-writing style.

Files:

• docs/reference/api/python-library-reference/nemo_fabric.streaming.md
• docs/reference/api/python-library-reference/nemo_fabric.client.md
• docs/reference/api/python-library-reference/nemo_fabric.runtime.md
• docs/reference/api/python-library-reference/nemo_fabric.errors.md
• docs/reference/api/python-library-reference/nemo_fabric.types.md
• docs/reference/api/python-library-reference/nemo_fabric.models.md

⚙️ CodeRabbit configuration file

{docs/**,README.md,AGENTS.md}: Review documentation for technical accuracy against the current API, command correctness, and consistency with generated schemas.
For links between files under docs/, require paths relative to the source file with the target file's .mdx extension so they work in both Fern builds and repository browsers. Flag Fern site-root links such as NeMo Fabric overview; use the repository-relative equivalent, such as NeMo Fabric overview.

Files:

• docs/reference/api/python-library-reference/nemo_fabric.streaming.md
• docs/reference/api/python-library-reference/nemo_fabric.client.md
• docs/reference/api/python-library-reference/nemo_fabric.runtime.md
• docs/reference/api/python-library-reference/nemo_fabric.errors.md
• docs/sdk/python.mdx
• docs/reference/api/python-library-reference/nemo_fabric.types.md
• docs/reference/api/python-library-reference/nemo_fabric.models.md

⚙️ CodeRabbit configuration file

{*.md,**/*.md,**/*.mdx,**/*.ipynb}: Enforce the product name in user-facing prose: use "NVIDIA NeMo Fabric" on first use and "NeMo Fabric" thereafter. Flag standalone capitalized "Fabric" when it refers to the product. Do not flag the lowercase fabric CLI command, package/import/crate names, code identifiers, API symbols, configuration keys, file paths, or unrelated generic uses of the word.

Files:

• docs/reference/api/python-library-reference/nemo_fabric.streaming.md
• docs/reference/api/python-library-reference/nemo_fabric.client.md
• docs/reference/api/python-library-reference/nemo_fabric.runtime.md
• docs/reference/api/python-library-reference/nemo_fabric.errors.md
• docs/sdk/python.mdx
• docs/reference/api/python-library-reference/nemo_fabric.types.md
• docs/reference/api/python-library-reference/nemo_fabric.models.md

📄 CodeRabbit inference engine (AGENTS.md)

Keep the stable public wrapper scripts/generate_api_docs.sh at the scripts/ root and reference it in docs and examples; use namespaced paths under scripts/docs/ only for internal maintenance documentation.

For Python API reference changes, update scripts/generate_api_docs.sh when the generator itself requires changes.

Files:

• scripts/generate_api_docs.sh

📄 CodeRabbit inference engine (.agents/skills/contribute-api/SKILL.md)

Determine and update every affected public surface, including the CLI, PyO3 bindings, Python SDK, type stubs, schemas, and adapter contract, so they remain in parity.

Files:

• tests/python/test_typed_config.py
• tests/docs/test_python_api_docs.py

📄 CodeRabbit inference engine (.agents/skills/prepare-pr/SKILL.md)

For native binding changes, run cargo check -p fabric-python --locked.

**/*.{rs,py}: When changing the Rust core or public schemas, run both the Rust and Python test suites.
When adding functionality, include tests in the corresponding Rust crate or the relevant area under tests/.

Files:

• tests/python/test_typed_config.py
• tests/docs/test_python_api_docs.py

📄 CodeRabbit inference engine (.agents/skills/validate-change/SKILL.md)

If Python code or a Python-facing adapter changes, run just test-python.

Files:

• tests/python/test_typed_config.py
• tests/docs/test_python_api_docs.py

📄 CodeRabbit inference engine (.agents/skills/validate-change/SKILL.md)

**/*.{rs,py,pyi}: If public configuration types change, confirm schema snapshot tests in just test-rust pass and review generated schema diffs.
For schema or public contract changes, run both language suites and review changes under schemas/ and generated API references.

Files:

• tests/python/test_typed_config.py
• tests/docs/test_python_api_docs.py

📄 CodeRabbit inference engine (.agents/skills/validate-change/SKILL.md)

For Python SDK or PyO3 binding changes, use python-tests, run focused pytest tests first, then just test-python; rebuild with just build-python when native code or packaging changes.

Files:

• tests/python/test_typed_config.py
• tests/docs/test_python_api_docs.py

📄 CodeRabbit inference engine (.agents/skills/python-tests/SKILL.md)

tests/**/*.py: Use Pytest to run Python tests.
Do not add @pytest.mark.asyncio to tests; async tests are automatically detected and run by the async runner.
Do not add -> None return type annotations to test functions.
When mocking a class, use unittest.mock.MagicMock or unittest.mock.AsyncMock, using the spec argument when necessary, rather than defining a new class.
Prefix mocked class names with mock, not fake.
Prefer pytest fixtures over helper methods.
Do not repeat fixtures; place fixtures needed by multiple test files in conftest.py.
Define fixtures using @pytest.fixture(name="<fixture_name>"[, scope="<scope>"]) and a function named <fixture_name>_fixture; specify scope only when it is not function.
Prefer pytest.mark.parametrize over separate tests for different input types.
Use @pytest.mark.usefixtures when a fixture is needed but its return value is unused or it does not return a value.
Use the autouse restore_environ_fixture from tests/conftest.py to restore environment variables; modify variables with os.environ and do not use monkeypatch.setenv.
Avoid defensive programming in tests; access expected data directly so missing data raises a clear failure, such as using results["data"] instead of results.get("data").

Files:

• tests/python/test_typed_config.py
• tests/docs/test_python_api_docs.py

📄 CodeRabbit inference engine (.agents/skills/update-project-version/SKILL.md)

When editing version helpers, verify every nemo-fabric-* workspace package through Cargo metadata and reject a static version in python/pyproject.toml.

Files:

• tests/python/test_typed_config.py
• tests/docs/test_python_api_docs.py

📄 CodeRabbit inference engine (.agents/skills/update-project-version/SKILL.md)

Avoid blind repository-wide replacement of version-like strings; distinguish package-version references from examples and unrelated dependency versions.

Files:

• tests/python/test_typed_config.py
• tests/docs/test_python_api_docs.py

📄 CodeRabbit inference engine (CONTRIBUTING.md)

Use type annotations for public Python APIs.

Files:

• tests/python/test_typed_config.py
• tests/docs/test_python_api_docs.py

📄 CodeRabbit inference engine (CONTRIBUTING.md)

**/*.{py,rs}: Keep native Python binding declarations synchronized with their Rust implementations.
Use snake_case for functions and variables; use PascalCase for Rust types and Python classes.

Files:

• tests/python/test_typed_config.py
• tests/docs/test_python_api_docs.py

⚙️ CodeRabbit configuration file

{tests/**,python/tests/**}: Tests should cover the behavior promised by the changed API surface, including error paths, lifecycle cleanup, and SDK/native parity where relevant.

Files:

• tests/python/test_typed_config.py
• tests/docs/test_python_api_docs.py

📄 CodeRabbit inference engine (.agents/skills/contribute-docs/SKILL.md)

In MDX files, use JSX comment delimiters ({/* and */}) for top-of-file comments, including SPDX headers; do not use HTML comments.

Use {/* ... */} delimiters for top-of-file MDX SPDX comments, not HTML comment delimiters.

Files:

• docs/sdk/python.mdx

📄 CodeRabbit inference engine (AGENTS.md)

Keep docs/sdk/python.mdx current when the public Python API changes.

Files:

• docs/sdk/python.mdx